home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 4 / Apprentice-Release4.iso / Source Code / Libraries / C Internet Config / IC Read Only ƒ / IC Headers ƒ / IC Component API Descriptions.h < prev    next >
Encoding:
Text File  |  1995-11-17  |  22.2 KB  |  92 lines  |  [TEXT/SPM ]
  1. count is set to 0.
  2. */
  3.  
  4. pascal ICError ICCGetIndPref(internetConfigurationComponent inst, long n, Str255 key)
  5. /*
  6.     You must specify a configuration before calling this routine.
  7.     You must be inside an ICBegin/End pair to call this routine.
  8.     Returns the key of the Nth preference.
  9.     n must be positive.
  10.     Returns icPrefNotFoundErr if n is greater than the total number of preferences.
  11.     If the routine returns an error, key is undefined.
  12. */
  13.  
  14. pascal ICError ICCDeletePref(internetConfigurationComponent inst, ConstStr255Param key)
  15. /*
  16.     You must specify a configuration before calling this routine.
  17.     You must be inside an ICBegin/End pair to call this routine.
  18.     Deletes the preference specified by key.
  19.     key must not be the empty string.
  20.     Returns icPrefNotFound if the preference specified by key is not present.
  21. */
  22.  
  23. pascal ICError ICCEnd(internetConfigurationComponent inst)
  24. /*
  25.     You must specify a configuration before calling this routine.
  26.     You must be inside an ICBegin/End pair to call this routine.
  27.     Terminates a preference session, as started by ICBegin.
  28.     You must have called ICBegin before calling this routine.
  29. */
  30.  
  31. /* ***** User Interface Stuff ***** */
  32.  
  33. pascal ICError ICCEditPreferences(internetConfigurationComponent inst, ConstStr255Param key)
  34. /*
  35.     Requires IC 1.1.
  36.     
  37.     You must specify a configuration before calling this routine.
  38.     You do not have to be inside an ICBegin/End pair to call this routine.
  39.     Instructs IC to display the user interface associated with editing
  40.     preferences and focusing on the preference specified by key.
  41.     If key is the empty string then no preference should be focused upon.
  42.     You must have specified a configuration before calling this routine.
  43.     You do not need to call ICBegin before calling this routine.
  44.     In the current implementation this launches the IC application
  45.     (or brings it to the front) and displays the window containing
  46.     the preference specified by key.
  47.     It may have a radically different implementation in future
  48.     IC systems.
  49. */
  50.  
  51. /* ***** URL Handling ***** */
  52.  
  53. pascal ICError ICCParseURL(internetConfigurationComponent inst, ConstStr255Param hint, Ptr data, long len,
  54.         long *selStart, long *selEnd, Handle url)
  55. /*
  56.     Requires IC 1.1.
  57.     
  58.     You must specify a configuration before calling this routine.
  59.     You do not have to be inside an ICBegin/End pair to call this routine.
  60.     Parses a URL out of the specified text and returns it in a canonical form
  61.     in a handle.
  62.     hint indicates the default scheme for URLs of the form "name@address".
  63.     If hint is the empty string then URLs of that form are not allowed.
  64.     data points to the start of the text. It must not be nil.
  65.     len indicates the length of the text. It must be non-negative.
  66.     selStart and selEnd should be passed in as the current selection of
  67.     the text. This selection is given in the same manner as TextEdit,
  68.     ie if selStart = selEnd then there is no selection only an insertion
  69.     point. Also selStart ≤ selEnd and 0 ≤ selStart ≤ len and 0 ≤ selEnd ≤ len.
  70.     selStart and selEnd are returned as the bounds of the URL. If the
  71.     routine returns an error then these new boundaries may be
  72.     invalid but they will be close.
  73.     The incoming url handle must not be nil.  The resulting URL is normalised
  74.     and copied into the url handle, which is resized to fit.
  75. */
  76.  
  77. pascal ICError ICCLaunchURL(internetConfigurationComponent inst, ConstStr255Param hint, Ptr data, long len,
  78.         long *selStart, long *selEnd)
  79. /*
  80.     Requires IC 1.1.
  81.     
  82.     You must specify a configuration before calling this routine.
  83.     You do not have to be inside an ICBegin/End pair to call this routine.
  84.     Parses a URL out of the specified text and feeds it off to the
  85.     appropriate helper.
  86.     hint indicates the default scheme for URLs of the form "name@address".
  87.     If hint is the empty string then URLs of that form are not allowed.
  88.     data points to the start of the text. It must not be nil.
  89.     len indicates the length of the text. It must be non-negative.
  90.     selStart and selEnd should be passed in as the current selection of
  91.     the text. This selection is given in the same manner as TextEdit,
  92.     ie if selStart = selEnd then there is no selection only an inse